BaseSubsystem Class

Represents the KINGSTAR Base Subsystem.

Inheritance hierarchy

System.Object
  IntervalZero.KINGSTAR.Base.Class.BaseSubsystem

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB 
public abstract class BaseSubsystem
Public MustInherit Class BaseSubsystem

 

The BaseSubsystem class exposes the following members.

Constructors

  Name Description
BaseSubsystem A creator for the BaseSubsystem class. This class contains the information about the KINGSTAR Base Subsystem.
BaseSubsystem A creator for the BaseSubsystem class. This class contains the information about the KINGSTAR Base Subsystem.

Events

  Name Description
PropertyChanged Notifies the application whether one of the properties is changed.

Methods

  Name Description
AddBoolVariable Add a user-defined variable in bool.
AddByteVariable Add a user-defined variable in 8-bit unsigned integer.
AddDIntVariable Add a user-defined variable in integer.
AddDirectoryVariable Add a directory variable.
AddDoubleVariable Add a user-defined variable in double.
AddDWordVariable Add a user-defined variable in unsigned integer.
AddFloatVariable Add a user-defined variable in float.
AddGroup Adds an axis group to the KINGSTAR Base Subsystem.
AddIntVariable Add a user-defined variable in short integer.
AddLIntVariable Add a user-defined variable in long integer.
AddLWordVariable Add a user-defined variable in unsigned long integer.
AddSIntVariable Add a user-defined variable in 8-bit integer.
AddVariable Add a user-defined variable.
AddWordVariable Add a user-defined variable in unsigned short integer.
DebugMessage Sends the KINGSTAR log messages to KINGSTAR Analysis Console.
Destroy Closes the link to the KINGSTAR Base Subsystem and terminates the Base Subsystem.
Exists Checks whether the variable exists.
GetAllBoolVariables Gets the list of user-defined variables in bool.
GetAllByteVariables Gets the list of user-defined variables in 8-bit unsigned integer.
GetAllDIntVariables Gets the list of user-defined variables in integer.
GetAllDirectoryVariables Gets the list of directory variables.
GetAllDoubleVariables Gets the list of user-defined variables in double.
GetAllDWordVariables Gets the list of user-defined variables in unsigned integer.
GetAllFloatVariables Gets the list of user-defined variables in float.
GetAllIntVariables Gets the list of user-defined variables in short integer.
GetAllLIntVariables Gets the list of user-defined variables in long integer.
GetAllLWordVariables Gets the list of user-defined variables in unsigned long integer.
GetAllSIntVariables Gets the list of user-defined variables in 8-bit integer.
GetAllVariables Gets the list of user-defined variables.
GetAllWordVariables Gets the list of user-defined variables in unsigned short integer.
GetBoolVariable Gets the details of a user-defined variable in bool.
GetByteVariable Gets the details of a user-defined variable in 8-bit unsigned integer.
GetCategoryName Gets a string assigned to a log ID.
GetDIntVariable Gets the details of a user-defined variable in integer.
GetDirectoryVariable Gets the details of directory variable.
GetDoubleVariable Gets the details of a user-defined variable in double.
GetDWordVariable Gets the details of a user-defined variable in unsigned integer.
GetFloatVariable Gets the details of a user-defined variable in float.
GetIntVariable Gets the details of a user-defined variable in short integer.
GetLIntVariable Gets the details of a user-defined variable in long integer.
GetLWordVariable Gets the details of a user-defined variable in unsigned long integer.
GetSIntVariable Gets the details of a user-defined variable in 8-bit integer.
GetVariable Gets the details of a user-defined variable.
GetWordVariable Gets the details of a user-defined variable in unsigned short integer.
Log Records the specified data in the logging shared memory.
PulseHeartbeat Sends a signal to notify KINGSTAR that the motion application is running properly.
ReadMemoryBool Reads a bit from the shared memory.
ReadMemoryByte Reads a byte from the shared memory.
ReadMemoryDouble Reads a double from the shared memory.
ReadMemoryInt16 Reads a short integer from the shared memory.
ReadMemoryInt32 Reads an integer from the shared memory.
ReadMemoryInt64 Reads a long integer from the shared memory.
ReadMemorySByte Reads an 8-bit signed integer from the shared memory.
ReadMemorySingle Reads a float from the shared memory.
ReadMemoryUInt16 Reads an unsigned short integer from the shared memory.
ReadMemoryUInt32 Reads an unsigned integer from the shared memory.
ReadMemoryUInt64 Reads an unsigned long integer from the shared memory.
RequestState Requests the KINGSTAR Base Subsystem to go into the specified EtherCAT state.
Restart Restarts the EtherCAT master.
SetCategoryName Sets a string to associate to a log ID.
Start Starts the KINGSTAR Base Subsystem.
Stop Stops the EtherCAT network and the KINGSTAR Base Subsystem.
StopAllLogs Stops recording the specified data in the logging shared memory.
UpdateConfiguration Updates the values of the module by reading them from the Base Subsystem.
WriteMemory (bool) Writes a bit into the shared memory.
WriteMemory (byte) Writes a byte into the shared memory.
WriteMemory (char) Writes a char into the shared memory.
WriteMemory (double) Writes a double into the shared memory.
WriteMemory (float) Writes a float into the shared memory.
WriteMemory (short) Writes a short integer into the shared memory.
WriteMemory (int) Writes an integer into the shared memory.
WriteMemory (long) Writes a long integer into the shared memory.
WriteMemory (ushort) Writes an unsigned short integer into the shared memory.
WriteMemory (uint) Writes an unsigned integer into the shared memory.
WriteMemory (ulong) Writes an unsigned long integer into the shared memory.

Properties

  Name Description
Access The data transfer mode for EtherCAT drives.
ActualCurrent Adds the actual current variable to PDO.
ActualTorque Adds the actual torque variable to PDO.
ActualVelocity Adds the actual velocity variable to PDO.
Alias Enables or disables the alias indexes for the axis and I/O index parameters in all methods.
AutoConfig Allows auto-config to be enabled.
AutoRepair Allows auto-repair to be enabled.
AutoRestart Allows for auto-restart to be enabled.
AutoUpdate Enables or disables the automatic configuration update.
Axes The list of axes.
AxisInput Enables or disables the access to the digital inputs of a servo drive.
AxisOutput Enables and disables the access to the digital outputs of a servo drive.
ConfiguredAxes Configures the settings of a simulated axis.
ConfiguredIos Configures the settings of a simulated I/O module.
ConfiguredModules Configures the settings for a real module.
CustomerId The customer ID you got when you purchase KINGSTAR.
Cycle The EtherCAT cycle time in second.
Dc Enables or disables DC synchronization. By default, it is true.
DcCheck Enables or disables DC checks during the startup of the KINGSTAR Base Subsystem.
DcMasterShift Chooses the shift mode.
DcReference Selects which device is the reference clock.
DcSystemTime The time stamp of the selected Sync0's signal of the distributed clock (DC).
FollowingError Adds the Following Error object to PDO.
Groups The list of axis groups.
Heartbeat Enables and disables the heartbeat.
HeartbeatTimeout The time period in which you need to use PulseHeartbeat to notify KINGSTAR that your application is running properly, or KINGSTAR assumes your application crashes and closes the EtherCAT link.
HotConnect Allows new hardware to be added while the EtherCAT network is running.
Initialized Checks whether the program is linked to the KINGSTAR Base Subsystem.
IOs The list of I/O modules.
Logging Shows whether a log command is recording.
MaxCurrent Adds the Maximum Current object to PDO.
MaxTorque Adds the Max Torque object to PDO.
ProfilePosition Adds Profile Velocity, Profile Acceleration, and Profile Deceleration variables to PDO.
Redundancy Enables or disables cable redundancy.
SecondEncoder Enables or disables the access to the internal position of an axis.
ServerLog Enables or disables the real-time server messages on RtxServer.
ShutdownHandler Attaches a shutdown handler while an EtherCAT connection is being established.
Slaves The list of EtherCAT slaves.
Started Checks whether the KINGSTAR Base Subsystem is started.
State The EtherCAT state of the master.
SynchronizedControlMode Enables or disables the Modes of Operation and Modes of Operation Display objects.
Tables The list of cam tables.
TorqueOffset Adds the torque offset variable to PDO.
TouchProbe Adds the TouchProbeControl and TouchProbeStatus variables to PDO.
Triggers Gets the details of a trigger.
UserVariableRepository Gets a user-defined variable.

See also

IntervalZero.KINGSTAR.Base.Class Namespace